Get-SqlAgentJob
Obtient un objet De travail SQL Agent pour chaque travail présent dans le instance cible de SQL Agent.
Syntax
Get-SqlAgentJob
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlAgentJob
[[-ServerInstance] <String[]>]
[-Credential <PSCredential>]
[-ConnectionTimeout <Int32>]
[[-Name] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlAgentJob
[[-Name] <String>]
[-InputObject] <JobServer>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Description
L’applet de commande Get-SqlAgentJob obtient un objet Sql Agent Job pour chaque travail présent dans le instance cible de SQL Agent. Si le nom du travail est fourni, l’applet de commande obtient uniquement cet objet de travail spécifique.
Cette applet de commande prend en charge les modes d’opération suivants pour obtenir une collection d’objets Job :
- Spécifiez le chemin d’accès de l’agent SQL instance.
- Passez le instance de l’agent SQL dans l’entrée.
- Appelez l’applet de commande dans un contexte valide.
Exemples
Exemple 1 : Obtenir toutes les instances de travail à partir du serveur spécifié instance
PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob
Name Owner Category Enabled CurrentRunStatus DateCreated LastModified JobID
---- ----- -------- ------- ---------------- ----------- ------------ -----
MyJob1 Owner [Uncategorized (Local)] True Idle 6/2/2016 10:21:44 AM 6/2/2016 10:21:44 AM 841255df-06e8-43ef-b798-3...
MyJob2 Owner [Uncategorized (Local)] True Idle 5/31/2016 2:40:58 PM 6/1/2016 5:09:40 PM 995b296a-cd35-4505-868a-3...
MyJob3 Owner [Uncategorized (Local)] True Idle 5/25/2016 12:13:56 PM 5/25/2016 12:13:56 PM 01d2e61a-9a90-4f77-98f4-e...
Cette commande obtient toutes les instances de travail du serveur instance nommées « MyServerInstance ».
Exemple 2 : Obtenir un instance de travail par nom à partir du serveur spécifié instance
PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob -Name MyJob1
Name Owner Category Enabled CurrentRunStatus DateCreated LastModified JobID
---- ----- -------- ------- ---------------- ----------- ------------ -----
MyJob1 Owner [Uncategorized (Local)] True Idle 6/2/2016 10:21:44 AM 6/2/2016 10:21:44 AM 841255df-06e8-43ef-b798-3...
Cette commande obtient le instance de travail nommé « MyJob1 » dans l’instance de serveur nommée « MyServerInstance ».
Paramètres
-AccessToken
Le jeton d’accès utilisé pour s’authentifier auprès de SQL Server, en guise d’alternative à l’authentification utilisateur/mot de passe ou à l’authentification 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 retourné en exécutant Get-AzAccessToken -ResourceUrl https://database.windows.net
.
Ce paramètre est nouveau dans v22 du module.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ConnectionTimeout
Spécifie le nombre de secondes d’attente d’une connexion serveur avant un échec de délai d’attente. La valeur de délai d’attente doit être une valeur entière comprise entre 0 et 65534. Si la valeur 0 est spécifiée, les tentatives de connexion n'expirent pas.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
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 v23+ 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 |
Accepted values: | Mandatory, Optional, Strict |
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 d’un 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 v22 du module.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Spécifie un objet SMO (SQL Management Objects) représentant le SQL Server Agent ciblé.
Type: | JobServer |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Spécifie le nom de l’objet Job que cette applet de commande obtient. Le nom peut ou non respecter la casse, en fonction du classement du SQL Server où l’Agent SQL s’exécute.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServerInstance
Spécifie, en tant que tableau de chaînes, le nom d’un instance de SQL Server où l’Agent SQL 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 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
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 v22 du module.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Sorties
System.Object