Get-SqlAgentSchedule

モジュール:

SQLServer

SQL エージェントのターゲット インスタンスに存在する各スケジュールの SQL ジョブ スケジュール オブジェクトを取得します。

構文

Get-SqlAgentSchedule
   [[-Name] <String>]
   [[-Path] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]

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

Get-SqlAgentSchedule
   [[-Name] <String>]
   [-InputObject] <JobServer>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [<CommonParameters>]

説明

Get-SqlAgentSchedule コマンドレットは、SQL エージェントのターゲット インスタンスに存在するスケジュールごとに SQL JobSchedule オブジェクトを取得します。 スケジュールの名前を指定すると、コマンドレットはその特定の JobSchedule オブジェクトのみを取得します。

コマンドレットは、Microsoft.SqlServer.Management.Smo.Agent.SharedSchedules SQL Server Management オブジェクト (SMO) オブジェクトに対してクエリを実行します。 特定のジョブに関連付けられているスケジュールに関心がある場合は、Get-SqlAgentJobSchedule コマンドレットを使用します。

このコマンドレットは、JobSchedule オブジェクトのコレクションを返す次の操作モードをサポートしています。

• SQL エージェントのインスタンスを指定します。
• ジョブ インスタンスの Path パラメーターを指定します。
• 有効なコンテキストでコマンドレットを呼び出します。

例

例 1: 指定したサーバー インスタンス上のすべてのジョブ スケジュールを取得する

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

このコマンドは、ジョブがない 'MyComputer' という名前のサーバー インスタンス上にある SQL エージェント上のすべてのジョブ スケジュールを取得します。

パラメーター

-AccessToken

ユーザー/パスワードまたは Windows 認証の代わりに、SQL Serverに対する認証に使用されるアクセス トークン。

これは、たとえば、 または を使用して にSQL Azure DB接続したりSQL Azure Managed Instance、 を使用したりManaged Identityするために使用Service Principalできます。

使用するパラメーターには、 を実行Get-AzAccessToken -ResourceUrl https://database.windows.netして返されるトークンまたはオブジェクトをPSAccessToken表す文字列を指定できます。

このパラメーターは、モジュールの v22 の新機能です。

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

-ConnectionTimeout

タイムアウトエラーが発生するまで、このコマンドレットがサーバー接続を待機する秒数を指定します。 タイムアウト値は、0 ~ 65534 の整数値である必要があります。 0 を指定した場合、接続の試行はタイムアウトしません。

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

-Credential

この操作を実行する権限を持つSQL Server ログインの資格情報を指定するために使用される PSCredential オブジェクトを指定します。

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

-Encrypt

SQL Serverに接続するときに使用する暗号化の種類。

この値は、 Encrypt Microsoft.Data.SqlClient ドライバーの SqlConnection オブジェクトの プロパティ SqlConnectionEncryptOption にマップされます。

モジュールの v22 では、既定値は Optional (v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "必須" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。

このパラメーターは、モジュールの v22 の新機能です。

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

-HostNameInCertificate

SQL Server TLS/SSL 証明書の検証に使われるホスト名。 SQL Server インスタンスで Force Encryption が有効になっており、hostname/shortname を使用してインスタンスに接続する場合は、このパラメーターを渡す必要があります。 このパラメーターを省略した場合、強制暗号化が有効になっているSQL Server インスタンスに接続するには、完全修飾ドメイン名 (FQDN) を -ServerInstance に渡す必要があります。

このパラメーターは、モジュールの v22 の新機能です。

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

-InputObject

ターゲット インスタンスのSQL Server エージェントを指定します。

Type:	JobServer
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

このコマンドレットが取得する JobSchedule オブジェクトの名前を指定します。

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

-Path

このコマンドレットが操作を実行するSQL Serverのエージェントへのパスを指定します。 このパラメーターの値を指定しない場合、コマンドレットは現在の作業場所を使用します。

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

-ServerInstance

SQL エージェントが実行されている配列として、SQL Serverのインスタンスの名前を指定します。 既定のインスタンスの場合は、コンピューター名 MyComputer のみを指定します。 名前付きインスタンスの場合は、ComputerName\InstanceName という形式を使用します。

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

-TrustServerCertificate

信頼を検証するために証明書チェーンの歩き方をバイパスしながらチャネルを暗号化するかどうかを示します。

モジュールの v22 では、既定値は $true (v21 との互換性のために) です。 モジュールの v23 以降では、既定値は "$false" になります。これにより、既存のスクリプトに破壊的変更が発生する可能性があります。

このパラメーターは、モジュールの v22 の新機能です。

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

入力

System.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer

出力

System.Object

関連リンク

• Get-SqlAgent
• Get-SqlAgentJob
• Get-SqlAgentJobHistory
• Get-SqlAgentJobStep