DatabaseProperties interface

Pacote:
@azure/arm-sql

As propriedades da base de dados.

Propriedades

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
availabilityZone

Especifica a zona de disponibilidade na qual o banco de dados está fixado.
catalogCollation

Agrupamento do catálogo de metadados.
collation

O agrupamento do banco de dados.
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.
creationDate

A data de criação da base de dados (formato ISO8601).
currentBackupStorageRedundancy

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

O nome atual do objetivo do nível de serviço da base de dados.
currentSku

O nome e a camada da SKU.
databaseId

O ID da base de dados.
defaultSecondaryLocation

A região secundária por defeito para esta base de dados.
earliestRestoreDate

Este regista a data e hora de início mais antigas disponíveis para esta base de dados (formato ISO8601).
elasticPoolId

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

O URI do cofre de chaves azure do banco de dados se estiver configurado com chaves gerenciadas pelo cliente do banco de dados.
encryptionProtectorAutoRotation

O sinalizador para ativar ou desativar a rotação automática da chave AKV do protetor de criptografia do banco de dados.
failoverGroupId

Identificador de recurso do Grupo de Failover ao qual pertence esta base de dados.
federatedClientId

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

Especifica o comportamento quando os limites livres mensais são esgotados para o banco de dados livre.

AutoPause: O banco de dados será pausado automaticamente após o esgotamento dos limites livres pelo restante do mês.

BillForUsage: O banco de dados continuará on-line após o esgotamento dos limites gratuitos e qualquer excesso de idade será cobrado.
highAvailabilityReplicaCount

O número de réplicas secundárias associadas ao banco de dados Business Critical, Premium ou Hyperscale edition que são usadas para fornecer alta disponibilidade. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico.
isInfraEncryptionEnabled

A encriptação infra está ativada para esta base de dados.
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.
keys

As ids de recurso das identidades atribuídas ao usuário a serem usadas
licenseType

O tipo de licença a ser aplicado para este banco de dados. LicenseIncluded se precisares de licença, ou BasePrice se tiveres licença e fores elegível para a Benefício Híbrido do Azure.
longTermRetentionBackupResourceId

O identificador de recurso do backup de retenção de longo prazo associado à operação de criação desse banco de dados.
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.
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.
maxLogSizeBytes

O tamanho máximo do log para esta base de dados.
maxSizeBytes

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

Capacidade mínima que o banco de dados sempre terá alocado, se não pausado
pausedDate

A data em que a base de dados foi pausada pela configuração do utilizador ou formato de ação(ISO8601). Nulo se a base de dados estiver pronta.
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.
preferredEnclaveType

Tipo de enclave solicitado no banco de dados, ou seja, enclaves padrão ou VBS.
readScale

O estado do roteamento somente leitura. Se ativadas, as ligações que tenham a intenção da aplicação definida para apenas leitura na sua cadeia de ligação podem ser encaminhadas para uma réplica secundária apenas de leitura na mesma região. Não aplicável a um banco de dados Hyperscale dentro de um pool elástico.
recoverableDatabaseId

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

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

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

O nome do objetivo do nível de serviço solicitado da base de dados.
restorableDroppedDatabaseId

O identificador de recurso do banco de dados descartado restaurável associado à operação de criação desse banco de dados.
restorePointInTime

Especifica o ponto no tempo (formato ISO8601) do banco de dados de origem que será restaurado para criar o novo banco de dados.
resumedDate

A data em que a base de dados foi retomada por ação do utilizador ou login da base de dados (formato ISO8601). Nulo se a base de dados estiver pausada.
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 for secundário. Os valores válidos são Geo, Named e Standby.
sourceDatabaseDeletionDate

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

O identificador de recurso do banco de dados de origem associado à operação de criação desse banco de dados.
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 mais detalhes sobre o cabeçalho "x-ms-authorization-auxiliary", veja https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
status

O estado da base de dados.
useFreeLimit

Se a base de dados utiliza ou não limites mensais gratuitos. Permitido em um banco de dados em uma assinatura.
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.

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).

creationDate?: Date

Valor de Propriedade

Date

currentBackupStorageRedundancy

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

currentBackupStorageRedundancy?: string

Valor de Propriedade

string

currentServiceObjectiveName

O nome atual do objetivo do nível de serviço da base de dados.

currentServiceObjectiveName?: string

Valor de Propriedade

string

currentSku

O nome e a camada da SKU.

currentSku?: Sku

Valor de Propriedade

Sku

databaseId

O ID da base de dados.

databaseId?: string

Valor de Propriedade

string

defaultSecondaryLocation

A região secundária por defeito para esta base de dados.

defaultSecondaryLocation?: string

Valor de Propriedade

string

earliestRestoreDate

Este regista a data e hora de início mais antigas disponíveis para esta base de dados (formato ISO8601).

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

encryptionProtectorAutoRotation

O sinalizador para ativar ou desativar a rotação automática da chave AKV do protetor de criptografia do banco de dados.

encryptionProtectorAutoRotation?: boolean

Valor de Propriedade

boolean

failoverGroupId

Identificador de recurso do Grupo de Failover ao qual pertence esta base de dados.

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

freeLimitExhaustionBehavior

Especifica o comportamento quando os limites livres mensais são esgotados para o banco de dados livre.

AutoPause: O banco de dados será pausado automaticamente após o esgotamento dos limites livres pelo restante do mês.

BillForUsage: O banco de dados continuará on-line após o esgotamento dos limites gratuitos e qualquer excesso de idade será cobrado.

freeLimitExhaustionBehavior?: string

Valor de Propriedade

string

highAvailabilityReplicaCount

O número de réplicas secundárias associadas ao banco de dados Business Critical, Premium ou Hyperscale edition 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

isInfraEncryptionEnabled

A encriptação infra está ativada para esta base de dados.

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?: Record<string, DatabaseKey>

Valor de Propriedade

Record<string, DatabaseKey>

licenseType

O tipo de licença a ser aplicado para este banco de dados. LicenseIncluded se precisares de licença, ou BasePrice se tiveres licença e fores elegível para a 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

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 esta base de dados.

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 a base de dados foi pausada pela configuração do utilizador ou formato de ação(ISO8601). Nulo se a base de dados estiver pronta.

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 ativadas, as ligações que tenham a intenção da aplicação definida para apenas leitura na sua cadeia de ligação podem ser encaminhadas para uma réplica secundária apenas de 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 do nível de serviço solicitado da base de dados.

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 a base de dados foi retomada por ação do utilizador ou login da base de dados (formato ISO8601). Nulo se a base de dados estiver pausada.

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

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 mais detalhes sobre o cabeçalho "x-ms-authorization-auxiliary", veja https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant

sourceResourceId?: string

Valor de Propriedade

string

status

O estado da base de dados.

status?: string

Valor de Propriedade

string

useFreeLimit

Se a base de dados utiliza ou não limites mensais gratuitos. Permitido em um banco de dados em uma assinatura.

useFreeLimit?: boolean

Valor de Propriedade

boolean

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