Get-SqlBackupHistory
Obtém informações de backup sobre bancos de dados e retorna objetos SMO BackupSet para cada registro de Backup encontrado com base nos parâmetros especificados para este cmdlet.
Sintaxe
ByPath (Padrão)
Get-SqlBackupHistory
[[-Path] <String[]>]
[-Since <SinceType>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-BackupType <BackupSetType>]
[-IncludeSnapshotBackups]
[-TimeSpan <TimeSpan>]
[-IgnoreProviderContext]
[-SuppressProviderContextWarning]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-DatabaseName <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>]
ByName
Get-SqlBackupHistory
[[-ServerInstance] <String[]>]
[-Since <SinceType>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-BackupType <BackupSetType>]
[-IncludeSnapshotBackups]
[-TimeSpan <TimeSpan>]
[-IgnoreProviderContext]
[-SuppressProviderContextWarning]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-DatabaseName <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>]
ByObject
Get-SqlBackupHistory
[-InputObject] <Server[]>
[-Since <SinceType>]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-BackupType <BackupSetType>]
[-IncludeSnapshotBackups]
[-TimeSpan <TimeSpan>]
[-IgnoreProviderContext]
[-SuppressProviderContextWarning]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-DatabaseName <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>]
Description
Esse cmdlet pesquisa a instância do servidor e obtém os registros de backup como objetos SMO BackupSet para todos os registros encontrados que correspondem aos parâmetros especificados.
Exemplos
Exemplo 1
PS C:\> Get-SqlBackupHistory -ServerInstance test-server -DatabaseName AdventureWorks2014
Name Type Backup Start Date Backup Finish Date
---- ---- ----------------- ------------------
AdventureWorks2014-Full Database Backup Database 2/21/2017 7:52:39 PM 2/21/2017 7:52:40 PM
AdventureWorks2014-Full Database Backup Database 3/20/2017 2:41:39 PM 3/20/2017 2:41:39 PM
AdventureWorks2014-Full-2017-07-24T22:22 Database 7/24/2017 3:23:11 PM 7/24/2017 3:23:11 PM
Este exemplo obtém registros para todos os tipos de backup do banco de dados AdventureWorks2014 na instância do SQL do servidor de teste.
Parâmetros
-AccessToken
O token de acesso usado para autenticar no SQL Server, como uma alternativa ao usuário/senha ou à Autenticação do Windows.
Isso pode ser usado, por exemplo, para se conectar SQL Azure DB e SQL Azure Managed Instance usar um Service Principal ou um Managed Identity.
O parâmetro a ser usado pode ser uma cadeia de caracteres que representa o token ou um PSAccessToken objeto conforme retornado executando Get-AzAccessToken -ResourceUrl https://database.windows.net.
Esse parâmetro é novo na v22 do módulo.
Propriedades do parâmetro
| Tipo: | PSObject |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-BackupType
O tipo de backup no qual filtrar. Se não for especificado, obtém todos os tipos de backup. Os valores aceitos são definidos abaixo.
Propriedades do parâmetro
| Tipo: | BackupSetType |
| Valor padrão: | None |
| Valores aceitos: | Database, Differential, Incremental, Log, FileOrFileGroup, FileOrFileGroupDifferential |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ConnectionTimeout
O tempo de espera em segundos para que uma conexão seja estabelecida e o parâmetro -DatabaseName gerado dinamicamente seja preenchido.
Propriedades do parâmetro
| Tipo: | Int32 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Credential
O objeto PSCredential cujos campos de nome de usuário e senha são usados para se conectar à instância do SQL.
Propriedades do parâmetro
| Tipo: | PSCredential |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-DatabaseName
Os nomes dos bancos de dados cujos registros de backup devem ser recuperados. Esse é um campo preenchido dinamicamente e, portanto, fornece sugestões de preenchimento automático em nomes de banco de dados.
Propriedades do parâmetro
| Tipo: | System.Collections.Generic.List`1[System.String] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Encrypt
O tipo de criptografia a ser usado ao se conectar ao SQL Server.
Esse valor é mapeado para a Encrypt propriedade SqlConnectionEncryptOption no objeto SqlConnection do driver Microsoft.Data.SqlClient.
Na v22 do módulo, o padrão é Optional (para compatibilidade com v21). Na v23+ do módulo, o valor padrão será 'Obrigatório', o que pode criar uma alteração significativa para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Valores aceitos: | Mandatory, Optional, Strict |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-EndTime
O tempo antes do qual todos os registros de backup a serem recuperados devem ter sido concluídos.
Propriedades do parâmetro
| Tipo: | DateTime |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-HostNameInCertificate
O nome do host a ser usado na validação do certificado TLS/SSL do SQL Server. Você deve passar esse parâmetro se a instância do SQL Server estiver habilitada para o Force Encryption e quiser se conectar a uma instância usando nome de host/nome curto. Se esse parâmetro for omitido, passar o FQDN (Nome de Domínio Totalmente Qualificado) para -ServerInstance será necessário para se conectar a uma instância do SQL Server habilitada para o Force Encryption.
Esse parâmetro é novo na v22 do módulo.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-IgnoreProviderContext
Indica que esse cmdlet não usa o contexto atual para substituir os valores dos parâmetros ServerInstance, DatabaseName . Se você não especificar esse parâmetro, o cmdlet ignorará os valores desses parâmetros, se possível, em favor do contexto no qual você executa o cmdlet.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-IncludeSnapshotBackups
Essa opção também fará com que o cmdlet obtenha registros para backups de instantâneo. Por padrão, esses backups não são recuperados.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-InputObject
Especifica objetos do servidor SMO para os quais obter os registros de backup.
Propriedades do parâmetro
| Tipo: | Server[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByObject
| Cargo: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Path
Especifica o caminho do provedor SQL para uma instância de servidor ou um banco de dados para esse cmdlet a ser usado para obter BackupSets. Se não for especificado, usará o local de trabalho atual.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByPath
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ServerInstance
O nome das instâncias de servidor que este cmdlet terá como destino.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ByName
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Since
Especifica uma abreviação que você pode, em vez do parâmetro StartTime.
Ele pode ser especificado com o parâmetro EndTime.
Você não poderá usar o parâmetro StartTime se usar esse parâmetro.
Os valores aceitáveis para este parâmetro são:
- Meia-noite (obtém todas as informações do histórico de trabalhos geradas após a meia-noite)
- Ontem (obtém todas as informações do histórico de trabalhos geradas nas últimas 24 horas)
- LastWeek (obtém todas as informações do histórico de trabalhos geradas na última semana)
- LastMonth (obtém todas as informações do histórico de trabalhos geradas no último mês)
Propriedades do parâmetro
| Tipo: | SinceType |
| Valor padrão: | None |
| Valores aceitos: | Midnight, Yesterday, LastWeek, LastMonth |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-StartTime
Obtém os registros de backup iniciados após esse horário especificado.
Propriedades do parâmetro
| Tipo: | DateTime |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-SuppressProviderContextWarning
Suprime o aviso quando o cmdlet estiver usando o contexto do provedor.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-TimeSpan
Se especificado, ele faz com que o cmdlet filtre registros gerados mais do que 'Timespan' atrás.
Propriedades do parâmetro
| Tipo: | TimeSpan |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-TrustServerCertificate
Indica se o canal será criptografado ao ignorar a cadeia de certificados para validar a confiança.
Na v22 do módulo, o padrão é $true (para compatibilidade com v21). Na v23+ do módulo, o valor padrão será "$false", o que pode criar uma alteração significativa para scripts existentes.
Esse parâmetro é novo na v22 do módulo.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.