Partager via


Get-SqlAgentSchedule

Obtient un objet de planification de travaux SQL pour chaque planification présente dans l’instance cible de SQL Agent.

Syntaxe

Get-SqlAgentSchedule
   [[-Name] <String>]
   [[-Path] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-SqlAgentSchedule
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [[-Name] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-SqlAgentSchedule
   [[-Name] <String>]
   [-InputObject] <JobServer>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

L’applet de commande Get-SqlAgentSchedule obtient un objet SQL JobSchedule pour chaque planification présente dans l’instance cible de SQL Agent. Si vous fournissez le nom de la planification, l’applet de commande obtient uniquement cet objet JobSchedule spécifique.

L’applet de commande interroge l’objet Microsoft.SqlServer.Management.Smo.Agent.SharedSchedules SQL Server Management Object (SMO). Si vous êtes intéressé par les planifications associées à un travail spécifique, utilisez l’applet de commande Get-SqlAgentJobSchedule.

Cette applet de commande prend en charge les modes d’opération suivants pour retourner une collection d’objets JobSchedule :

  • Spécifiez l’instance de SQL Agent.
  • Spécifiez le paramètre Path de l’instance de travail.
  • Appelez l’applet de commande dans un contexte valide.

Exemples

Exemple 1 : Obtenir toutes les planifications de travail sur l’instance de serveur spécifiée

PS C:\> Get-SqlAgentSchedule -ServerInstance MyComputer | ? { $_.JobCount -eq 0 }

Name                           Jobs  Enabled    DateCreated               ActiveStartDate           ActiveEndDate             ID
----                           ----  -------    -----------               ---------------           -------------             --
EveryDay                       0     True       4/13/2016 11:36:30 AM     4/13/2016 12:00:00 AM     12/31/9999 12:00:00 AM    3
OnceAWeek                      0     True       4/13/2016 11:36:30 AM     4/13/2016 12:00:00 AM     12/31/9999 12:00:00 AM    4

Cette commande obtient toutes les planifications de travaux sur l’Agent SQL qui se trouvent sur l’instance de serveur nommée « MyComputer » qui n’ont aucun travail.

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

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

Ce paramètre est nouveau dans v22 du module.

Type:PSObject
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ConnectionTimeout

Spécifie le nombre de secondes pendant lesquelles cette applet de commande attend une connexion serveur avant une défaillance de délai d’attente. La valeur de délai d’attente doit être une valeur entière comprise entre 0 et 65534. Si 0 est spécifié, les tentatives de connexion n’expirent pas.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Credential

Spécifie un objet PSCredential utilisé pour spécifier les informations d’identification d’une connexion SQL Server autorisée à effectuer cette opération.

Type:PSCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Encrypt

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

Cette valeur est mappée à la propriété EncryptSqlConnectionEncryptOption 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.

Type:String
Valeurs acceptées:Mandatory, Optional, Strict
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-HostNameInCertificate

Nom d’hôte à utiliser pour valider le certificat TLS/SSL SQL Server. 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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InputObject

Spécifie l’agent SQL Server de l’instance cible.

Type:JobServer
Position:2
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

Spécifie le nom de l’objet JobSchedule que cette applet de commande obtient.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Path

Spécifie le chemin d’accès à l’agent de SQL Server sur lequel cette applet de commande exécute l’opération. Si vous ne spécifiez pas de valeur pour ce paramètre, l’applet de commande utilise l’emplacement de travail actuel.

Type:String
Position:2
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProgressAction

Détermine comment PowerShell répond aux mises à jour de progression générées par un script, une applet de commande ou un fournisseur, telles que les barres de progression générées par l’applet de commande Write-Progress. L’applet de commande Write-Progress crée des barres de progression qui affichent l’état d’une commande.

Type:ActionPreference
Alias:proga
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ServerInstance

Spécifie le nom d’une instance de SQL Server, en tant que tableau, où SQL Agent est en cours d’exécution. Pour les instances par défaut, spécifiez uniquement le nom de l’ordinateur : MyComputer. Pour les instances nommées, utilisez le format ComputerName\InstanceName.

Type:String[]
Position:2
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

System.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer

Sorties

System.Object