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.

Syntax

Get-SqlBackupHistory
   [-Since <SinceType>]
   [-StartTime <DateTime>]
   [-EndTime <DateTime>]
   [-BackupType <BackupSetType>]
   [-IncludeSnapshotBackups]
   [-TimeSpan <TimeSpan>]
   [-IgnoreProviderContext]
   [-SuppressProviderContextWarning]
   [[-Path] <String[]>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-DatabaseName <System.Collections.Generic.List`1[System.String]>]
   [<CommonParameters>]
Get-SqlBackupHistory
   [-Since <SinceType>]
   [-StartTime <DateTime>]
   [-EndTime <DateTime>]
   [-BackupType <BackupSetType>]
   [-IncludeSnapshotBackups]
   [-TimeSpan <TimeSpan>]
   [-IgnoreProviderContext]
   [-SuppressProviderContextWarning]
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-DatabaseName <System.Collections.Generic.List`1[System.String]>]
   [<CommonParameters>]
Get-SqlBackupHistory
   [-Since <SinceType>]
   [-StartTime <DateTime>]
   [-EndTime <DateTime>]
   [-BackupType <BackupSetType>]
   [-IncludeSnapshotBackups]
   [-TimeSpan <TimeSpan>]
   [-IgnoreProviderContext]
   [-SuppressProviderContextWarning]
   [-InputObject] <Server[]>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-DatabaseName <System.Collections.Generic.List`1[System.String]>]
   [<CommonParameters>]

Description

Cette applet de commande recherche le serveur instance et obtient les enregistrements de sauvegarde en tant qu’objets BackupSet SMO 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 pour la base de données AdventureWorks2014 sur le serveur de test SQL instance.

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 à et à SQL Azure DB l’aide d’un Service Principal ou d’un Managed Identity.SQL Azure Managed Instance

Le paramètre à utiliser peut être une chaîne représentant le jeton ou un PSAccessToken objet tel que retourné par l’exécution Get-AzAccessToken -ResourceUrl https://database.windows.netde .

Ce paramètre est nouveau dans la version 22 du module.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BackupType

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

Type:BackupSetType
Accepted values:Database, Differential, Incremental, Log, FileOrFileGroup, FileOrFileGroupDifferential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTimeout

Temps d’attente en secondes pour qu’une connexion soit établie et le paramètre -DatabaseName généré dynamiquement à remplir.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

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

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:System.Collections.Generic.List`1[System.String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 la version 22 du module.

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EndTime

Heure avant laquelle tous les enregistrements de sauvegarde à récupérer doivent être terminés.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

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

Ce paramètre est nouveau dans la version 22 du module.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IgnoreProviderContext

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeSnapshotBackups

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Spécifie les objets serveur SMO pour 1000 dont les enregistrements de sauvegarde doivent être enregistrés.

Type:Server[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

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

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

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

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Since

Spécifie une abréviation que vous pouvez utiliser 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 valides pour ce paramètre sont :

  • 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 au cours de la dernière semaine)
  • LastMonth (obtient toutes les informations d’historique des travaux générées au cours du dernier mois)
Type:SinceType
Accepted values:Midnight, Yesterday, LastWeek, LastMonth
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StartTime

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

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SuppressProviderContextWarning

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 ».

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrustServerCertificate

Indique si le canal sera chiffré tout en contournant 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 la version 22 du module.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

System.String[]

Microsoft.SqlServer.Management.Smo.Server[]

Sorties

System.Object