sp_help_proxy (Transact-SQL)

適用対象:SQL Server

1 つ以上のプロキシの情報を一覧表示します。

Transact-SQL 構文表記規則

構文

  
sp_help_proxy   
    [ @proxy_id = ] id,  
    [ @proxy_name = ] 'proxy_name' ,  
    [ @subsystem_name = ] 'subsystem_name' ,  
    [ @name = ] 'name'  

引数

[ @proxy_id = ] id 情報を一覧表示するプロキシのプロキシ識別番号。 proxy_idは int で、既定値は NULL です。 id または proxy_nameのいずれかを指定できます。

[ @proxy_name = ] 'proxy_name' 情報を一覧表示するプロキシの名前。 proxy_nameは sysname で、既定値は NULL です。 id または proxy_nameのいずれかを指定できます。

[ @subsystem_name = ] 'subsystem_name' プロキシを一覧表示するサブシステムの名前。 subsystem_nameは sysname で、既定値は NULL です。 subsystem_nameを指定する場合は、name も指定する必要があります。

次の表に、各サブシステムの値を示します。

値	説明
ActiveScripting	ActiveX スクリプト
CmdExec	オペレーティング システム (CmdExec)
スナップショット	レプリケーション スナップショット エージェント
LogReader	レプリケーション ログ リーダー エージェント
Distribution	レプリケーション ディストリビューション エージェント
Merge	Replication Merge Agent
QueueReader	Replication Queue Reader Agent
ANALYSISQUERY	Analysis Services コマンド
ANALYSISCOMMAND	Analysis Services クエリ
Dts	SSIS パッケージ実行
PowerShell	PowerShell スクリプト

[ @name = ] 'name'プロキシを一覧表示するSQL Server ログインの名前。 名前は nvarchar(256)で、既定値は NULL です。 name を指定する場合は、subsystem_nameも指定する必要があります。

リターン コードの値

0 (成功) または 1 (失敗)

結果セット

列名	データ型	説明
proxy_id	int	プロキシ識別番号。
name	sysname	プロキシの名前。
credential_identity	sysname	プロキシに関連付けられている資格情報の Microsoft Windows ドメイン名とユーザー名。
有効	tinyint	プロキシが有効かどうか { 0 = 無効、 1 = 有効 }
description	nvarchar(1024)	このプロキシの説明。
user_sid	varbinary(85)	プロキシに関する Windows ユーザーの Windows セキュリティ ID
credential_id	int	このプロキシに関連付けられている資格情報の識別子。
credential_identity_exists	int	credential_identity が存在するかどうか { 0 = 存在しません、1 = 存在}

解説

パラメーターが指定されていない場合、 sp_help_proxy インスタンス内のすべてのプロキシの情報が一覧表示されます。

ログインが特定のサブシステムに使用できるプロキシを決定するには、 名前 と subsystem_nameを指定します。 これらの引数を指定すると、 sp_help_proxy は、指定されたログインがアクセスできるプロキシと、指定したサブシステムで使用できるプロキシを一覧表示します。

アクセス許可

既定では、このストアド プロシージャを実行できるのは、 sysadmin 固定サーバー ロールのメンバーです。 それ以外のユーザーには、 msdb データベースの SQLAgentOperatorRole 固定サーバー ロールを与える必要があります。

SQLAgentOperatorRole の詳細については、「固定データベース ロールのSQL Server エージェント」を参照してください。

注意

credential_identity列とuser_sid列は、sysadmin のメンバーがこのストアド プロシージャを実行した場合にのみ結果セットで返されます。

例

A. すべてのプロキシに関する情報を一覧表示する

次の例では、インスタンス内のすべてのプロキシの情報を一覧表示します。

USE msdb ;  
GO  
  
EXEC dbo.sp_help_proxy ;  
GO  

B. 特定のプロキシの情報を一覧表示する

次の例では、 という名前 Catalog application proxyのプロキシの情報を一覧表示します。

USE msdb ;  
GO  
  
EXEC dbo.sp_help_proxy  
    @proxy_name = N'Catalog application proxy' ;  
GO  

参照

SQL Server エージェントのストアド プロシージャ (Transact-SQL)
sp_add_proxy (Transact-SQL)
sp_delete_proxy (Transact-SQL)