sp_help_proxy (Transact-SQL)

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)

    Snapshot

    レプリケーション スナップショット エージェント

    LogReader

    レプリケーション ログ リーダー エージェント

    Distribution

    レプリケーション ディストリビューション エージェント

    Merge

    レプリケーション マージ エージェント

    QueueReader

    レプリケーション キュー リーダー エージェント

    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 ドメイン名およびユーザー名

enabled

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 ではインスタンスのすべてのプロキシに関する情報が一覧表示されます。

指定されたサブシステムに対してログインが使用できるプロキシを調べるには、name および 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