Partager via


Get-SqlBackupHistory

Obtient des informations de sauvegarde sur les bases de données et retourne des objets SMO BackupSet pour chaque enregistrement de sauvegarde trouvé en fonction des paramètres spécifiés dans cette applet de commande.

Syntaxe

ByPath (Par défaut)

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

Cette applet de commande recherche l’instance de serveur et obtient les enregistrements de sauvegarde en tant qu’objets SMO BackupSet pour tous les enregistrements trouvés correspondant aux paramètres spécifiés.

Exemples

Exemple 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

Cet exemple obtient des enregistrements pour tous les types de sauvegarde de la base de données AdventureWorks2014 sur une instance SQL de test server.

Paramètres

-AccessToken

Jeton d’accès utilisé pour s’authentifier auprès de SQL Server, comme alternative à l’authentification utilisateur/mot de passe ou Windows.

Cela peut être utilisé, par exemple, pour se connecter à SQL Azure DBSQL Azure Managed Instance un Service Principal ou un Managed Identity.

Le paramètre à utiliser peut être une chaîne représentant le jeton ou un PSAccessToken objet tel qu’il est retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net.

Ce paramètre est nouveau dans v22 du module.

Propriétés du paramètre

Type:PSObject
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-BackupType

Type de sauvegarde sur lequel filtrer. Si ce n’est pas spécifié, obtient tous les types de sauvegarde. Les valeurs acceptées sont définies ci-dessous.

Propriétés du paramètre

Type:BackupSetType
Valeur par défaut:None
Valeurs acceptées:Database, Differential, Incremental, Log, FileOrFileGroup, FileOrFileGroupDifferential
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ConnectionTimeout

Délai d’attente en secondes pour qu’une connexion soit établie et le paramètre de -DatabaseName généré dynamiquement doit être rempli.

Propriétés du paramètre

Type:Int32
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Credential

Objet PSCredential dont les champs nom d’utilisateur et mot de passe sont utilisés pour se connecter à l’instance SQL.

Propriétés du paramètre

Type:PSCredential
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DatabaseName

Noms des bases de données dont les enregistrements de sauvegarde doivent être récupérés. Il s’agit d’un champ rempli dynamiquement et fournit donc des suggestions de saisie semi-automatique sur les noms de base de données.

Propriétés du paramètre

Type:

System.Collections.Generic.List`1[System.String]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Encrypt

Type de chiffrement à utiliser lors de la connexion à SQL Server.

Cette valeur est mappée à la Encrypt propriété SqlConnectionEncryptOption sur l’objet SqlConnection du pilote Microsoft.Data.SqlClient.

Dans la version 22 du module, la valeur par défaut est Optional (pour la compatibilité avec v21). Dans la version 23+ du module, la valeur par défaut est « Obligatoire », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:Mandatory, Optional, Strict
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-EndTime

Heure de récupération de tous les enregistrements de sauvegarde à récupérer.

Propriétés du paramètre

Type:DateTime
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat SQL Server TLS/SSL. Vous devez passer ce paramètre si votre instance SQL Server est activée pour Forcer le chiffrement et que vous souhaitez vous connecter à une instance à l’aide du nom d’hôte/shortname. Si ce paramètre est omis, le passage du nom de domaine complet (FQDN) à -ServerInstance est nécessaire pour se connecter à une instance SQL Server activée pour Forcer le chiffrement.

Ce paramètre est nouveau dans v22 du module.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IgnoreProviderContext

Indique que cette applet de commande n’utilise pas le contexte actuel pour remplacer les valeurs des paramètres ServerInstance, DatabaseName . Si vous ne spécifiez pas ce paramètre, l’applet de commande ignore les valeurs de ces paramètres, si possible, en faveur du contexte dans lequel vous exécutez l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IncludeSnapshotBackups

Ce commutateur permet également à l’applet de commande d’obtenir des enregistrements pour les sauvegardes d’instantanés. Par défaut, ces sauvegardes ne sont pas récupérées.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

Spécifie les objets SMO Server pour utilisant les enregistrements de sauvegarde.

Propriétés du paramètre

Type:

Server[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByObject
Position:1
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Path

Spécifie le chemin d’accès du fournisseur SQL à une instance de serveur ou à une base de données pour cette applet de commande à utiliser pour obtenir des BackupSets. S’il n’est pas spécifié, il utilise l’emplacement de travail actuel.

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByPath
Position:1
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ServerInstance

Nom des instances de serveur que cette applet de commande cible.

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByName
Position:1
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Since

Spécifie une abréviation que vous pouvez au lieu du paramètre StartTime.

Il peut être spécifié avec le paramètre EndTime.

Vous ne pouvez pas utiliser le paramètre StartTime si vous utilisez ce paramètre.

Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Minuit (obtient toutes les informations d’historique des travaux générées après minuit)
  • Hier (obtient toutes les informations d’historique des travaux générées au cours des dernières 24 heures)
  • LastWeek (obtient toutes les informations d’historique des travaux générées dans la semaine dernière)
  • LastMonth (obtient toutes les informations d’historique des travaux générées au cours du dernier mois)

Propriétés du paramètre

Type:SinceType
Valeur par défaut:None
Valeurs acceptées:Midnight, Yesterday, LastWeek, LastMonth
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-StartTime

Obtient les enregistrements de sauvegarde qui ont démarré après cette heure spécifiée.

Propriétés du paramètre

Type:DateTime
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SuppressProviderContextWarning

Supprime l’avertissement lorsque l’applet de commande utilise le contexte du fournisseur.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-TimeSpan

Si elle est spécifiée, l’applet de commande filtre les enregistrements générés il y a plus de « Timespan ».

Propriétés du paramètre

Type:TimeSpan
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-TrustServerCertificate

Indique si le canal sera chiffré lors du contournement de la marche à pied de la chaîne de certificats pour valider l’approbation.

Dans la version 22 du module, la valeur par défaut est $true (pour la compatibilité avec v21). Dans v23+ du module, la valeur par défaut est « $false », ce qui peut créer une modification cassant pour les scripts existants.

Ce paramètre est nouveau dans v22 du module.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

System.String

Microsoft.SqlServer.Management.Smo.Server

Sorties

System.Object